Resource OperationDefinition/FHIR Server from package hl7.fhir.us.consent-management#current (47 ms)

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "revoke-consent",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition revoke-consent</b></p><a name=\"revoke-consent\"> </a><a name=\"hcrevoke-consent\"> </a><a name=\"revoke-consent-en-US\"> </a><p>URL: [base]/Consent/$revokeConsent</p><p>Input parameters Profile:<a href=\"StructureDefinition-revokeConsentParameters.html\">Revoke Consent Operation Parameters</a></p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>consent</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-FASTConsent.html\" title=\"http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent\">FASTConsent</a>)</td><td/><td><div><p>A reference to the Consent instance to revoke</p>\n</div></td></tr><tr><td>IN</td><td>consent</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html\" title=\"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient\">US Core Patient Profile</a>)</td><td/><td><div><p>A reference to the Patient who the revoked Consent is about</p>\n</div></td></tr><tr><td>IN</td><td>document</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a> (<a href=\"StructureDefinition-FASTDocumentReference.html\" title=\"http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTDocumentReference\">FASTDocumentReference</a>, <a href=\"StructureDefinition-FASTQuestionnaireResponse.html\" title=\"http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTQuestionnaireResponse\">FASTQuestionnaireResponse</a>)</td><td/><td><div><p>Accompanying documentation for the revocation of the Consent</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cbcc"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 1,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/consent-management/ImplementationGuide/hl7.fhir.us.consent-management"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/consent-management/OperationDefinition/revoke-consent",
  "version" : "0.1.0",
  "name" : "RevokeConsent",
  "title" : "Revoke a Consent",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2025-04-23T18:18:45+00:00",
  "publisher" : "HL7 International / Community Based Collaborative Care",
  "contact" : [
    {
      "name" : "HL7 International / Community Based Collaborative Care",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cbcc"
        }
      ]
    }
  ],
  "description" : "This operation is used to revoke a consent with a consent administration service.  The parameters are a reference to the Consent resource along with accompanying documentation in the form of DocumentReferences (for PDF or other forms) or QuestionnaireResponses.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "code" : "revokeConsent",
  "resource" : [
    "Consent"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/consent-management/StructureDefinition/revokeConsentParameters",
  "parameter" : [
    {
      "name" : "consent",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "A reference to the Consent instance to revoke",
      "type" : "Reference",
      "targetProfile" : [
        "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent"
      ]
    },
    {
      "name" : "consent",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "A reference to the Patient who the revoked Consent is about",
      "type" : "Reference",
      "targetProfile" : [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
      ]
    },
    {
      "name" : "document",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Accompanying documentation for the revocation of the Consent",
      "type" : "Resource",
      "targetProfile" : [
        "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTDocumentReference",
        "http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTQuestionnaireResponse"
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.